<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>OPENSSL_malloc</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:" />
</head>

<body>



<ul id="index">
  <li><a href="#NAME">NAME</a></li>
  <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
  <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
  <li><a href="#RETURN-VALUES">RETURN VALUES</a></li>
  <li><a href="#NOTES">NOTES</a></li>
  <li><a href="#COPYRIGHT">COPYRIGHT</a></li>
</ul>

<h1 id="NAME">NAME</h1>

<p>OPENSSL_malloc_init, OPENSSL_malloc, OPENSSL_zalloc, OPENSSL_realloc, OPENSSL_free, OPENSSL_clear_realloc, OPENSSL_clear_free, OPENSSL_cleanse, CRYPTO_malloc, CRYPTO_zalloc, CRYPTO_realloc, CRYPTO_free, OPENSSL_strdup, OPENSSL_strndup, OPENSSL_memdup, OPENSSL_strlcpy, OPENSSL_strlcat, OPENSSL_hexstr2buf, OPENSSL_buf2hexstr, OPENSSL_hexchar2int, CRYPTO_strdup, CRYPTO_strndup, OPENSSL_mem_debug_push, OPENSSL_mem_debug_pop, CRYPTO_mem_debug_push, CRYPTO_mem_debug_pop, CRYPTO_clear_realloc, CRYPTO_clear_free, CRYPTO_get_mem_functions, CRYPTO_set_mem_functions, CRYPTO_get_alloc_counts, CRYPTO_set_mem_debug, CRYPTO_mem_ctrl, CRYPTO_mem_leaks, CRYPTO_mem_leaks_fp, CRYPTO_mem_leaks_cb, OPENSSL_MALLOC_FAILURES, OPENSSL_MALLOC_FD - Memory allocation functions</p>

<h1 id="SYNOPSIS">SYNOPSIS</h1>

<pre><code> <span class="comment">#include &lt;openssl/crypto.h&gt;</span>
 
 <span class="keyword">int</span> <span class="variable">OPENSSL_malloc_init</span><span class="operator">(</span><span class="variable">void</span><span class="operator">)</span>
 
 <span class="variable">void</span> <span class="variable">*OPENSSL_malloc</span><span class="operator">(</span><span class="variable">size_t</span> <span class="variable">num</span><span class="operator">)</span>
 <span class="variable">void</span> <span class="variable">*OPENSSL_zalloc</span><span class="operator">(</span><span class="variable">size_t</span> <span class="variable">num</span><span class="operator">)</span>
 <span class="variable">void</span> <span class="variable">*OPENSSL_realloc</span><span class="operator">(</span><span class="variable">void</span> <span class="variable">*addr</span><span class="operator">,</span> <span class="variable">size_t</span> <span class="variable">num</span><span class="operator">)</span>
 <span class="variable">void</span> <span class="variable">OPENSSL_free</span><span class="operator">(</span><span class="variable">void</span> <span class="variable">*addr</span><span class="operator">)</span>
 <span class="variable">char</span> <span class="variable">*OPENSSL_strdup</span><span class="operator">(</span><span class="variable">const</span> <span class="variable">char</span> <span class="variable">*str</span><span class="operator">)</span>
 <span class="variable">char</span> <span class="variable">*OPENSSL_strndup</span><span class="operator">(</span><span class="variable">const</span> <span class="variable">char</span> <span class="variable">*str</span><span class="operator">,</span> <span class="variable">size_t</span> <span class="regex">s)
 size_t OPENSSL_strlcat(char *dst, const char *src, size_t size);
 size_t OPENSSL_strlcpy(char *dst, const char *src, size_t size)</span><span class="operator">;</span>
 <span class="variable">void</span> <span class="variable">*OPENSSL_memdup</span><span class="operator">(</span><span class="variable">void</span> <span class="variable">*data</span><span class="operator">,</span> <span class="variable">size_t</span> <span class="regex">s)
 void *OPENSSL_clear_realloc(void *p, size_t old_len, size_t num)
 void OPENSSL_clear_free(void *str, size_t num)</span>
 <span class="variable">void</span> <span class="variable">OPENSSL_cleanse</span><span class="operator">(</span><span class="variable">void</span> <span class="variable">*ptr</span><span class="operator">,</span> <span class="variable">size_t</span> <span class="variable">len</span><span class="operator">);</span>
 
 <span class="variable">unsigned</span> <span class="variable">char</span> <span class="variable">*OPENSSL_hexstr2buf</span><span class="operator">(</span><span class="variable">const</span> <span class="variable">char</span> <span class="variable">*str</span><span class="operator">,</span> <span class="variable">long</span> <span class="variable">*len</span><span class="operator">);</span>
 <span class="variable">char</span> <span class="variable">*OPENSSL_buf2hexstr</span><span class="operator">(</span><span class="variable">const</span> <span class="variable">unsigned</span> <span class="variable">char</span> <span class="variable">*buffer</span><span class="operator">,</span> <span class="variable">long</span> <span class="variable">len</span><span class="operator">);</span>
 <span class="keyword">int</span> <span class="variable">OPENSSL_hexchar2int</span><span class="operator">(</span><span class="variable">unsigned</span> <span class="variable">char</span> <span class="variable">c</span><span class="operator">);</span>
 
 <span class="variable">void</span> <span class="variable">*CRYPTO_malloc</span><span class="operator">(</span><span class="variable">size_t</span> <span class="variable">num</span><span class="operator">,</span> <span class="variable">const</span> <span class="variable">char</span> <span class="variable">*file</span><span class="operator">,</span> <span class="keyword">int</span> <span class="variable">line</span><span class="operator">)</span>
 <span class="variable">void</span> <span class="variable">*CRYPTO_zalloc</span><span class="operator">(</span><span class="variable">size_t</span> <span class="variable">num</span><span class="operator">,</span> <span class="variable">const</span> <span class="variable">char</span> <span class="variable">*file</span><span class="operator">,</span> <span class="keyword">int</span> <span class="variable">line</span><span class="operator">)</span>
 <span class="variable">void</span> <span class="variable">*CRYPTO_realloc</span><span class="operator">(</span><span class="variable">void</span> <span class="variable">*p</span><span class="operator">,</span> <span class="variable">size_t</span> <span class="variable">num</span><span class="operator">,</span> <span class="variable">const</span> <span class="variable">char</span> <span class="variable">*file</span><span class="operator">,</span> <span class="keyword">int</span> <span class="variable">line</span><span class="operator">)</span>
 <span class="variable">void</span> <span class="variable">CRYPTO_free</span><span class="operator">(</span><span class="variable">void</span> <span class="variable">*str</span><span class="operator">,</span> <span class="variable">const</span> <span class="variable">char</span> <span class="operator">*,</span> <span class="keyword">int</span><span class="operator">)</span>
 <span class="variable">char</span> <span class="variable">*CRYPTO_strdup</span><span class="operator">(</span><span class="variable">const</span> <span class="variable">char</span> <span class="variable">*p</span><span class="operator">,</span> <span class="variable">const</span> <span class="variable">char</span> <span class="variable">*file</span><span class="operator">,</span> <span class="keyword">int</span> <span class="variable">line</span><span class="operator">)</span>
 <span class="variable">char</span> <span class="variable">*CRYPTO_strndup</span><span class="operator">(</span><span class="variable">const</span> <span class="variable">char</span> <span class="variable">*p</span><span class="operator">,</span> <span class="variable">size_t</span> <span class="variable">num</span><span class="operator">,</span> <span class="variable">const</span> <span class="variable">char</span> <span class="variable">*file</span><span class="operator">,</span> <span class="keyword">int</span> <span class="variable">line</span><span class="operator">)</span>
 <span class="variable">void</span> <span class="variable">*CRYPTO_clear_realloc</span><span class="operator">(</span><span class="variable">void</span> <span class="variable">*p</span><span class="operator">,</span> <span class="variable">size_t</span> <span class="variable">old_len</span><span class="operator">,</span> <span class="variable">size_t</span> <span class="variable">num</span><span class="operator">,</span>
                            <span class="variable">const</span> <span class="variable">char</span> <span class="variable">*file</span><span class="operator">,</span> <span class="keyword">int</span> <span class="variable">line</span><span class="operator">)</span>
 <span class="variable">void</span> <span class="variable">CRYPTO_clear_free</span><span class="operator">(</span><span class="variable">void</span> <span class="variable">*str</span><span class="operator">,</span> <span class="variable">size_t</span> <span class="variable">num</span><span class="operator">,</span> <span class="variable">const</span> <span class="variable">char</span> <span class="operator">*,</span> <span class="keyword">int</span><span class="operator">)</span>
 
 <span class="variable">void</span> <span class="variable">CRYPTO_get_mem_functions</span><span class="operator">(</span>
         <span class="variable">void</span> <span class="operator">*(**</span><span class="regex">m)(size_t, const char *, int)</span><span class="operator">,</span>
         <span class="variable">void</span> <span class="operator">*(**</span><span class="variable">r</span><span class="operator">)(</span><span class="variable">void</span> <span class="operator">*,</span> <span class="variable">size_t</span><span class="operator">,</span> <span class="variable">const</span> <span class="variable">char</span> <span class="operator">*,</span> <span class="keyword">int</span><span class="operator">),</span>
         <span class="variable">void</span> <span class="operator">(**</span><span class="variable">f</span><span class="operator">)(</span><span class="variable">void</span> <span class="operator">*,</span> <span class="variable">const</span> <span class="variable">char</span> <span class="operator">*,</span> <span class="keyword">int</span><span class="operator">))</span>
 <span class="keyword">int</span> <span class="variable">CRYPTO_set_mem_functions</span><span class="operator">(</span>
         <span class="variable">void</span> <span class="operator">*(</span><span class="variable">*m</span><span class="operator">)(</span><span class="variable">size_t</span><span class="operator">,</span> <span class="variable">const</span> <span class="variable">char</span> <span class="operator">*,</span> <span class="keyword">int</span><span class="operator">),</span>
         <span class="variable">void</span> <span class="operator">*(</span><span class="variable">*r</span><span class="operator">)(</span><span class="variable">void</span> <span class="operator">*,</span> <span class="variable">size_t</span><span class="operator">,</span> <span class="variable">const</span> <span class="variable">char</span> <span class="operator">*,</span> <span class="keyword">int</span><span class="operator">),</span>
         <span class="variable">void</span> <span class="operator">(</span><span class="variable">*f</span><span class="operator">)(</span><span class="variable">void</span> <span class="operator">*,</span> <span class="variable">const</span> <span class="variable">char</span> <span class="operator">*,</span> <span class="keyword">int</span><span class="operator">))</span>
 
 <span class="variable">void</span> <span class="variable">CRYPTO_get_alloc_counts</span><span class="operator">(</span><span class="keyword">int</span> <span class="variable">*m</span><span class="operator">,</span> <span class="keyword">int</span> <span class="variable">*r</span><span class="operator">,</span> <span class="keyword">int</span> <span class="variable">*f</span><span class="operator">)</span>
 
 <span class="keyword">int</span> <span class="variable">CRYPTO_set_mem_debug</span><span class="operator">(</span><span class="keyword">int</span> <span class="variable">onoff</span><span class="operator">)</span>
 
 <span class="variable">env</span> <span class="variable">OPENSSL_MALLOC_FAILURES</span><span class="operator">=...</span> <span class="operator">&lt;</span><span class="variable">application</span><span class="operator">&gt;</span>
 <span class="variable">env</span> <span class="variable">OPENSSL_MALLOC_FD</span><span class="operator">=...</span> <span class="operator">&lt;</span><span class="variable">application</span><span class="operator">&gt;</span>
 
 <span class="keyword">int</span> <span class="variable">CRYPTO_mem_ctrl</span><span class="operator">(</span><span class="keyword">int</span> <span class="variable">mode</span><span class="operator">);</span>
 
 <span class="keyword">int</span> <span class="variable">OPENSSL_mem_debug_push</span><span class="operator">(</span><span class="variable">const</span> <span class="variable">char</span> <span class="variable">*info</span><span class="operator">)</span>
 <span class="keyword">int</span> <span class="variable">OPENSSL_mem_debug_pop</span><span class="operator">(</span><span class="variable">void</span><span class="operator">);</span>
 
 <span class="keyword">int</span> <span class="variable">CRYPTO_mem_debug_push</span><span class="operator">(</span><span class="variable">const</span> <span class="variable">char</span> <span class="variable">*info</span><span class="operator">,</span> <span class="variable">const</span> <span class="variable">char</span> <span class="variable">*file</span><span class="operator">,</span> <span class="keyword">int</span> <span class="variable">line</span><span class="operator">);</span>
 <span class="keyword">int</span> <span class="variable">CRYPTO_mem_debug_pop</span><span class="operator">(</span><span class="variable">void</span><span class="operator">);</span>
 
 <span class="keyword">int</span> <span class="variable">CRYPTO_mem_leaks</span><span class="operator">(</span><span class="variable">BIO</span> <span class="variable">*b</span><span class="operator">);</span>
 <span class="keyword">int</span> <span class="variable">CRYPTO_mem_leaks_fp</span><span class="operator">(</span><span class="variable">FILE</span> <span class="variable">*fp</span><span class="operator">);</span>
 <span class="keyword">int</span> <span class="variable">CRYPTO_mem_leaks_cb</span><span class="operator">(</span><span class="keyword">int</span> <span class="operator">(</span><span class="variable">*cb</span><span class="operator">)(</span><span class="variable">const</span> <span class="variable">char</span> <span class="variable">*str</span><span class="operator">,</span> <span class="variable">size_t</span> <span class="variable">len</span><span class="operator">,</span> <span class="variable">void</span> <span class="variable">*u</span><span class="operator">),</span>
                         <span class="variable">void</span> <span class="variable">*u</span><span class="operator">);</span>
</code></pre>

<h1 id="DESCRIPTION">DESCRIPTION</h1>

<p>OpenSSL memory allocation is handled by the <b>OPENSSL_xxx</b> API. These are generally macro&#39;s that add the standard C <b>__FILE__</b> and <b>__LINE__</b> parameters and call a lower-level <b>CRYPTO_xxx</b> API. Some functions do not add those parameters, but exist for consistency.</p>

<p>OPENSSL_malloc_init() does nothing and does not need to be called. It is included for compatibility with older versions of OpenSSL.</p>

<p>OPENSSL_malloc(), OPENSSL_realloc(), and OPENSSL_free() are like the C malloc(), realloc(), and free() functions. OPENSSL_zalloc() calls memset() to zero the memory before returning.</p>

<p>OPENSSL_clear_realloc() and OPENSSL_clear_free() should be used when the buffer at <b>addr</b> holds sensitive information. The old buffer is filled with zero&#39;s by calling OPENSSL_cleanse() before ultimately calling OPENSSL_free().</p>

<p>OPENSSL_cleanse() fills <b>ptr</b> of size <b>len</b> with a string of 0&#39;s. Use OPENSSL_cleanse() with care if the memory is a mapping of a file. If the storage controller uses write compression, then its possible that sensitive tail bytes will survive zeroization because the block of zeros will be compressed. If the storage controller uses wear leveling, then the old sensitive data will not be overwritten; rather, a block of 0&#39;s will be written at a new physical location.</p>

<p>OPENSSL_strdup(), OPENSSL_strndup() and OPENSSL_memdup() are like the equivalent C functions, except that memory is allocated by calling the OPENSSL_malloc() and should be released by calling OPENSSL_free().</p>

<p>OPENSSL_strlcpy(), OPENSSL_strlcat() and OPENSSL_strnlen() are equivalents of the common C library functions and are provided for portability.</p>

<p>OPENSSL_hexstr2buf() parses <b>str</b> as a hex string and returns a pointer to the parsed value. The memory is allocated by calling OPENSSL_malloc() and should be released by calling OPENSSL_free(). If <b>len</b> is not NULL, it is filled in with the output length. Colons between two-character hex &quot;bytes&quot; are ignored. An odd number of hex digits is an error.</p>

<p>OPENSSL_buf2hexstr() takes the specified buffer and length, and returns a hex string for value, or NULL on error. <b>Buffer</b> cannot be NULL; if <b>len</b> is 0 an empty string is returned.</p>

<p>OPENSSL_hexchar2int() converts a character to the hexadecimal equivalent, or returns -1 on error.</p>

<p>If no allocations have been done, it is possible to &quot;swap out&quot; the default implementations for OPENSSL_malloc(), OPENSSL_realloc and OPENSSL_free() and replace them with alternate versions (hooks). CRYPTO_get_mem_functions() function fills in the given arguments with the function pointers for the current implementations. With CRYPTO_set_mem_functions(), you can specify a different set of functions. If any of <b>m</b>, <b>r</b>, or <b>f</b> are NULL, then the function is not changed.</p>

<p>The default implementation can include some debugging capability (if enabled at build-time). This adds some overhead by keeping a list of all memory allocations, and removes items from the list when they are free&#39;d. This is most useful for identifying memory leaks. CRYPTO_set_mem_debug() turns this tracking on and off. In order to have any effect, is must be called before any of the allocation functions (e.g., CRYPTO_malloc()) are called, and is therefore normally one of the first lines of main() in an application. CRYPTO_mem_ctrl() provides fine-grained control of memory leak tracking. To enable tracking call CRYPTO_mem_ctrl() with a <b>mode</b> argument of the <b>CRYPTO_MEM_CHECK_ON</b>. To disable tracking call CRYPTO_mem_ctrl() with a <b>mode</b> argument of the <b>CRYPTO_MEM_CHECK_OFF</b>.</p>

<p>While checking memory, it can be useful to store additional context about what is being done. For example, identifying the field names when parsing a complicated data structure. OPENSSL_mem_debug_push() (which calls CRYPTO_mem_debug_push()) attachs an identifying string to the allocation stack. This must be a global or other static string; it is not copied. OPENSSL_mem_debug_pop() removes identifying state from the stack.</p>

<p>At the end of the program, calling CRYPTO_mem_leaks() or CRYPTO_mem_leaks_fp() will report all &quot;leaked&quot; memory, writing it to the specified BIO <b>b</b> or FILE <b>fp</b>. These functions return 1 if there are no leaks, 0 if there are leaks and -1 if an error occurred.</p>

<p>CRYPTO_mem_leaks_cb() does the same as CRYPTO_mem_leaks(), but instead of writing to a given BIO, the callback function is called for each output string with the string, length, and userdata <b>u</b> as the callback parameters.</p>

<p>If the library is built with the <code>crypto-mdebug</code> option, then one function, CRYPTO_get_alloc_counts(), and two additional environment variables, <b>OPENSSL_MALLOC_FAILURES</b> and <b>OPENSSL_MALLOC_FD</b>, are available.</p>

<p>The function CRYPTO_get_alloc_counts() fills in the number of times each of CRYPTO_malloc(), CRYPTO_realloc(), and CRYPTO_free() have been called, into the values pointed to by <b>mcount</b>, <b>rcount</b>, and <b>fcount</b>, respectively. If a pointer is NULL, then the corresponding count is not stored.</p>

<p>The variable <b>OPENSSL_MALLOC_FAILURES</b> controls how often allocations should fail. It is a set of fields separated by semicolons, which each field is a count (defaulting to zero) and an optional atsign and percentage (defaulting to 100). If the count is zero, then it lasts forever. For example, <code><span class="number">100</span><span class="operator">;</span><span class="variable">@25</span>
</code> or <code><span class="number">100</span><span class="variable">@0</span><span class="operator">;</span><span class="number">0</span><span class="variable">@25</span>
</code> means the first 100 allocations pass, then all other allocations (until the program exits or crashes) have a 25% chance of failing.</p>

<p>If the variable <b>OPENSSL_MALLOC_FD</b> is parsed as a positive integer, then it is taken as an open file descriptor, and a record of all allocations is written to that descriptor. If an allocation will fail, and the platform supports it, then a backtrace will be written to the descriptor. This can be useful because a malloc may fail but not be checked, and problems will only occur later. The following example in classic shell syntax shows how to use this (will not work on all platforms):</p>

<pre><code>  <span class="variable">OPENSSL_MALLOC_FAILURES</span><span class="operator">=</span><span class="string">'200;@10'</span>
  <span class="variable">export</span> <span class="variable">OPENSSL_MALLOC_FAILURES</span>
  <span class="variable">OPENSSL_MALLOC_FD</span><span class="operator">=</span><span class="number">3</span>
  <span class="variable">export</span> <span class="variable">OPENSSL_MALLOC_FD</span>
  <span class="operator">...</span><span class="variable">app</span> <span class="variable">invocation</span><span class="operator">...</span> <span class="number">3</span><span class="operator">&gt;</span><span class="regex">/tmp/log</span><span class="variable">$$</span>
</code></pre>

<h1 id="RETURN-VALUES">RETURN VALUES</h1>

<p>OPENSSL_malloc_init(), OPENSSL_free(), OPENSSL_clear_free() CRYPTO_free(), CRYPTO_clear_free() and CRYPTO_get_mem_functions() return no value.</p>

<p>CRYPTO_mem_leaks(), CRYPTO_mem_leaks_fp() and CRYPTO_mem_leaks_cb() return 1 if there are no leaks, 0 if there are leaks and -1 if an error occurred.</p>

<p>OPENSSL_malloc(), OPENSSL_zalloc(), OPENSSL_realloc(), OPENSSL_clear_realloc(), CRYPTO_malloc(), CRYPTO_zalloc(), CRYPTO_realloc(), CRYPTO_clear_realloc(), OPENSSL_buf2hexstr(), OPENSSL_hexstr2buf(), OPENSSL_strdup(), and OPENSSL_strndup() return a pointer to allocated memory or NULL on error.</p>

<p>CRYPTO_set_mem_functions() and CRYPTO_set_mem_debug() return 1 on success or 0 on failure (almost always because allocations have already happened).</p>

<p>CRYPTO_mem_ctrl() returns -1 if an error occurred, otherwise the previous value of the mode.</p>

<p>OPENSSL_mem_debug_push() and OPENSSL_mem_debug_pop() return 1 on success or 0 on failure.</p>

<h1 id="NOTES">NOTES</h1>

<p>While it&#39;s permitted to swap out only a few and not all the functions with CRYPTO_set_mem_functions(), it&#39;s recommended to swap them all out at once. <i>This applies specially if OpenSSL was built with the configuration option</i> <code>crypto-mdebug</code> <i>enabled. In case, swapping out only, say, the malloc() implementation is outright dangerous.</i></p>

<h1 id="COPYRIGHT">COPYRIGHT</h1>

<p>Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.</p>

<p>Licensed under the OpenSSL license (the &quot;License&quot;). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <a href="https://www.openssl.org/source/license.html">https://www.openssl.org/source/license.html</a>.</p>


</body>

</html>


